Get Customer PCRF Configuration
Get Customer PCRF Configuration API is used to retrieve PCRF configuration details for an account per given provider. For example, retrieving PCRF preset group IDs available to be used for the account per specific provider to determine subscribers’ surfing bandwidth, thus enabling and disabling throttling.
NOTE: This API should be used when there is a need to retrieve more than 10K records in a single query. This API does not support pagination.
| HTTP URL | |
|---|---|
| GET | api/v2/customer/{id}/provider{id}/pcrf-config |
NOTE: Provider {id} is the provider code.
Eligibility
The Requestor is eligible to request his own account PCRF settings information.
API Request
Not applicable
API Response
Response Structure
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| errorCode | String | O | Failure code. See list below, under ‘Error Codes’ section |
| errorMessage | String | O | Failure detailed description. See list below, under ‘Error Codes’ section |
| content | Object | O | Array of main response body object. Displayed when an API call was successful. For a failure it will be empty. |
| pageable | Object | O | Paging information object. Displayed when an API call was successful. For a failure it will be empty. |
Content
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| groupId | String | M | Array of PCRF related group IDs, configured and can be used by the customer per given provider. |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
| Code | Message |
|---|---|
| GLOBAL_1001 | Service unavailable. Please try again. |
| SUBSCRIBER_1002 | Subscriber does not exist. |
Examples
Request Body not applicable.
{
}
Request Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"groupId": ["1","15","35"]
}
],
"pageable": null
}
Response Body: Failure NAK
{
"errorCode": "GLOBAL_1001",
"errorMessage": "Service unavailable. Please try again",
"content": "",
"pageable": null
}